GET api/v2/addressbook/contacts/lookup?destinations[0]={destinations[0]}&destinations[1]={destinations[1]}
This method is used to translate destinations into addressbook contact names if they're are avaliable
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
destinations |
A list of destinations for which you want to get a contact names |
Collection of string |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of destinations and their relative contact names
TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.AddressBooks.ContactsNameSwapName | Description | Type | Additional information |
---|---|---|---|
Error | TwoSms.CustomerPortalRole.API.Misc.Error |
None. |
|
ResponseData | TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.AddressBooks.ContactsNameSwap |
None. |
Response Formats
application/json, text/json
Sample:
{ "Error": { "ErrorCode": "sample string 1", "ErrorReason": "sample string 2" }, "ResponseData": { "Identification": { "UserId": "sample string 1" }, "Result": "sample string 1", "Detail": [ { "ContactName": "sample string 1", "Destination": "sample string 2" }, { "ContactName": "sample string 1", "Destination": "sample string 2" } ] } }
application/xml, text/xml
Sample:
<ResponseOfListOfContactsNameSwap xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error> <ErrorCode>sample string 1</ErrorCode> <ErrorReason>sample string 2</ErrorReason> </Error> <ResponseData> <Result>sample string 1</Result> <Identification> <UserId>sample string 1</UserId> </Identification> <Detail> <ContactsNameSwap> <ContactName>sample string 1</ContactName> <Destination>sample string 2</Destination> </ContactsNameSwap> <ContactsNameSwap> <ContactName>sample string 1</ContactName> <Destination>sample string 2</Destination> </ContactsNameSwap> </Detail> </ResponseData> </ResponseOfListOfContactsNameSwap>